Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@wordpress/deprecated
Advanced tools
@wordpress/deprecated is a utility package used in WordPress development to handle deprecated features. It provides a way to mark functions, methods, or other features as deprecated, allowing developers to notify users of the deprecation and suggest alternatives.
Marking a function as deprecated
This feature allows developers to mark a function as deprecated. The `deprecated` function is called with the name of the deprecated function, the version since it is deprecated, an alternative function, and the plugin name. This helps in notifying users about the deprecation and suggesting an alternative.
const deprecated = require('@wordpress/deprecated');
function oldFunction() {
deprecated('oldFunction', {
version: '1.0.0',
alternative: 'newFunction',
plugin: 'my-plugin'
});
// Function logic
}
The `util-deprecate` package is a Node.js utility that provides a similar functionality to mark functions as deprecated. It is a lightweight solution that outputs a warning message when a deprecated function is called. Compared to @wordpress/deprecated, it is more general-purpose and not specifically tailored for WordPress development.
The `depd` package is another Node.js utility for deprecating functions and methods. It provides a way to mark functions as deprecated and outputs a warning message when they are used. Like `util-deprecate`, it is not specific to WordPress but serves a similar purpose in notifying developers and users about deprecated features.
Deprecation utility for WordPress. Logs a message to notify developers about a deprecated feature.
Install the module
npm install @wordpress/deprecated --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default
in your code.
The deprecated
action is fired with three parameters: the name of the deprecated feature, the options object passed to deprecated, and the message sent to the console.
Example:
import { addAction } from '@wordpress/hooks';
function addDeprecationAlert( message, { version } ) {
alert( `Deprecation: ${ message }. Version: ${ version }` );
}
addAction(
'deprecated',
'my-plugin/add-deprecation-alert',
addDeprecationAlert
);
Logs a message to notify developers about a deprecated feature.
Usage
import deprecated from '@wordpress/deprecated';
deprecated( 'Eating meat', {
since: '2019.01.01'
version: '2020.01.01',
alternative: 'vegetables',
plugin: 'the earth',
hint: 'You may find it beneficial to transition gradually.',
} );
// Logs: 'Eating meat is deprecated since version 2019.01.01 and will be removed from the earth in version 2020.01.01. Please use vegetables instead. Note: You may find it beneficial to transition gradually.'
Parameters
string
: Name of the deprecated feature.[Object]
: Personalisation options[string]
: Version in which the feature was deprecated.[string]
: Version in which the feature will be removed.[string]
: Feature to use instead[string]
: Plugin name if it's a plugin feature[string]
: Link to documentation[string]
: Additional message to help transition away from the deprecated feature.Object map tracking messages which have been logged, for use in ensuring a message is only logged once.
Type
Record<string, true | undefined>
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.
FAQs
Deprecation utility for WordPress.
The npm package @wordpress/deprecated receives a total of 97,021 weekly downloads. As such, @wordpress/deprecated popularity was classified as popular.
We found that @wordpress/deprecated demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 23 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.